home *** CD-ROM | disk | FTP | other *** search
/ Super PC 34 / Super PC 34 (Shareware).iso / spc / UTIL / DJGPP2 / CONTRIB / MAN_PC.ZIP / man_pc / whatis / mkwhatis.8 < prev    next >
Encoding:
Text File  |  1995-06-20  |  1.3 KB  |  57 lines
  1.  
  2.  MKWHATIS(8)                                                     MKWHATIS(8)
  3.  
  4.  NAME
  5.       mkwhatis - tool for making entries in whatis(1) databases
  6.  
  7.  SYNOPSIS
  8.       mkwhatis manpage...
  9.  
  10.  DESCRIPTION
  11.       mkwhatis reads the input files (which should be manpage source files)
  12.       and extracts information for the database used by whatis(1).  It is
  13.       not perfect, but should help substantially in this otherwise tedious
  14.       task.
  15.  
  16.  NOTES
  17.       For the format of the whatis database, see whatis(5).
  18.  
  19.       whatis assumes manpages that look like this:
  20.  
  21.            .TH FOO 1X          <-- section, subsection
  22.            .SH NAME
  23.            foo \- blah blah blah    <-- name, desc
  24.            .SH DESCIPTION
  25.            .
  26.            .
  27.            .
  28.            .SH "SEE ALSO"
  29.            bar(1), foobar(5)   <-- cross references
  30.            .SH SOMETHING  (or eof)
  31.  
  32.       or
  33.  
  34.            .TH FOO 1 LOCAL
  35.            .
  36.            .
  37.            .
  38.  
  39.       It does not handle sourced files (aliases), ie:
  40.  
  41.            .so man1/foo.1
  42.  
  43.       At a minimum, you will have to add keywords yourself.
  44.  
  45.  SEE ALSO
  46.       man(1), whatis(1), whatisin(1), apropos(1), whatis(5)
  47.  
  48.  AUTHOR
  49.       Bill Rosenkranz
  50.       rosenkra@convex.com
  51.  
  52.  VERSION
  53.       mkwhatis 2.0.1 92/9/12 rosenkra
  54.  
  55.                                     - 1 -          Formatted:  June 18, 1995
  56.  
  57.